-
Notifications
You must be signed in to change notification settings - Fork 134
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat!: Wire the provider module to return ValidatorUpdates, instead of the staking module #1993
feat!: Wire the provider module to return ValidatorUpdates, instead of the staking module #1993
Conversation
This reverts commit 62dfd1e.
WalkthroughWalkthroughThe changes predominantly involve updates, corrections, and new feature additions across various modules. There's a significant focus on renaming types from Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Validator
participant ConsumerChain
participant ProviderChain
participant Module
User->>Validator: Proposes block
Validator->>ConsumerChain: Submits block
ConsumerChain->>ProviderChain: Relays block info
ProviderChain->>Module: Updates validator set
Module->>ProviderChain: Returns validator updates
ProviderChain->>ConsumerChain: Sends validator updates
ConsumerChain->>Validator: Updates validator set
Validator->>User: Confirms validation
Recent review detailsConfiguration used: .coderabbit.yml Files selected for processing (1)
Additional context usedPath-based instructions (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
.github/workflows/nightly-e2e.yml
Outdated
inactive-provider-validators-on-consumer-test: | ||
runs-on: ubuntu-latest | ||
timeout-minutes: 20 | ||
steps: | ||
- uses: actions/setup-go@v5 | ||
with: | ||
go-version: "1.22" | ||
- uses: actions/checkout@v4 | ||
- name: Checkout LFS objects | ||
run: git lfs checkout | ||
- name: Setup Go | ||
uses: actions/setup-go@v5 | ||
with: | ||
go-version: "1.22" # The Go version to download (if necessary) and use. | ||
- name: E2E active set changes | ||
run: go run ./tests/e2e/... --tc inactive-provider-validators-on-consumer | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ensure consistency in job naming and steps.
The new job inactive-provider-validators-on-consumer-test
is consistent with other E2E test jobs. However, the step name E2E active set changes
should be updated to reflect the actual test being run.
- - name: E2E active set changes
+ - name: E2E inactive provider validators on consumer test
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
inactive-provider-validators-on-consumer-test: | |
runs-on: ubuntu-latest | |
timeout-minutes: 20 | |
steps: | |
- uses: actions/setup-go@v5 | |
with: | |
go-version: "1.22" | |
- uses: actions/checkout@v4 | |
- name: Checkout LFS objects | |
run: git lfs checkout | |
- name: Setup Go | |
uses: actions/setup-go@v5 | |
with: | |
go-version: "1.22" # The Go version to download (if necessary) and use. | |
- name: E2E active set changes | |
run: go run ./tests/e2e/... --tc inactive-provider-validators-on-consumer | |
inactive-provider-validators-on-consumer-test: | |
runs-on: ubuntu-latest | |
timeout-minutes: 20 | |
steps: | |
- uses: actions/setup-go@v5 | |
with: | |
go-version: "1.22" | |
- uses: actions/checkout@v4 | |
- name: Checkout LFS objects | |
run: git lfs checkout | |
- name: Setup Go | |
uses: actions/setup-go@v5 | |
with: | |
go-version: "1.22" # The Go version to download (if necessary) and use. | |
- name: E2E inactive provider validators on consumer test | |
run: go run ./tests/e2e/... --tc inactive-provider-validators-on-consumer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks rabbit
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@p-offtermatt, you're welcome! If you need any further assistance, feel free to ask.
// get the bonded validators from the staking module | ||
bondedValidators, err := k.stakingKeeper.GetBondedValidatorsByPower(ctx) | ||
if err != nil { | ||
panic(fmt.Errorf("failed to get bonded validators: %w", err)) |
Check warning
Code scanning / CodeQL
Panic in BeginBock or EndBlock consensus methods Warning
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
Outside diff range and nitpick comments (4)
x/ccv/provider/keeper/relay.go (4)
152-156
: Document the logic for updating the provider consensus validator set.The comments indicate the importance of updating the provider validator set before the rest of the logic. Ensure that this is well-documented and understood by maintainers to prevent future issues.
189-189
: Clarify the purpose of currentValidators.Add a comment to clarify the purpose of
currentValidators
and its role in the function.// get the last validator set sent to consensus currentValidators := k.GetLastProviderConsensusValSet(ctx)
193-196
: Avoid potential out of range errors.The code bounds
maxValidators
to the number of bonded validators to avoid out of range errors. Ensure this logic is correct and add a comment explaining it.// avoid out of range errors by bounding the max validators to the number of bonded validators if maxValidators > int64(len(bondedValidators)) { maxValidators = int64(len(bondedValidators)) }
209-211
: Document the DiffValidators function.Add a comment to explain what
DiffValidators
does to improve maintainability.// calculate the difference between the current and next validator sets valUpdates := DiffValidators(currentValidators, nextValidators)
…2012) * Add initialization for validator cap * Remove migration test * Fix inconsistent naming
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
Outside diff range, codebase verification and nitpick comments (1)
x/ccv/provider/migrations/vX/migrations.go (1)
1-16
: Add logging to track execution.Adding logging statements will help track the execution of the function and debug any issues that may arise.
import ( "log" ) func InitializeMaxValidatorsForExistingConsumers(ctx sdk.Context, providerKeeper providerkeeper.Keeper) { log.Println("Initializing max validators for existing consumers") maxVals := providerKeeper.GetParams(ctx).MaxProviderConsensusValidators for _, chainID := range providerKeeper.GetAllRegisteredConsumerChainIDs(ctx) { log.Printf("Setting max validators for chainID: %s\n", chainID) providerKeeper.SetValidatorSetCap(ctx, chainID, uint32(maxVals)) } log.Println("Finished initializing max validators for existing consumers") }
package v6 | ||
|
||
import ( | ||
sdk "github.com/cosmos/cosmos-sdk/types" | ||
providerkeeper "github.com/cosmos/interchain-security/v5/x/ccv/provider/keeper" | ||
) | ||
|
||
// InitializeMaxValidatorsForExistingConsumers initializes the max validators | ||
// parameter for existing consumers to the MaxProviderConsensusValidators parameter. | ||
// This is necessary to avoid those consumer chains having an excessive amount of validators. | ||
func InitializeMaxValidatorsForExistingConsumers(ctx sdk.Context, providerKeeper providerkeeper.Keeper) { | ||
maxVals := providerKeeper.GetParams(ctx).MaxProviderConsensusValidators | ||
for _, chainID := range providerKeeper.GetAllRegisteredConsumerChainIDs(ctx) { | ||
providerKeeper.SetValidatorSetCap(ctx, chainID, uint32(maxVals)) | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Handle potential errors from providerKeeper methods.
The providerKeeper
methods may return errors that should be handled to ensure the function executes correctly.
func InitializeMaxValidatorsForExistingConsumers(ctx sdk.Context, providerKeeper providerkeeper.Keeper) error {
maxVals, err := providerKeeper.GetParams(ctx).MaxProviderConsensusValidators
if err != nil {
return err
}
chainIDs, err := providerKeeper.GetAllRegisteredConsumerChainIDs(ctx)
if err != nil {
return err
}
for _, chainID := range chainIDs {
if err := providerKeeper.SetValidatorSetCap(ctx, chainID, uint32(maxVals)); err != nil {
return err
}
}
return nil
}
Use a more descriptive function name.
The function name could be more descriptive to indicate that it sets the max validators for existing consumers.
func SetMaxValidatorsForExistingConsumers(ctx sdk.Context, providerKeeper providerkeeper.Keeper) error {
maxVals, err := providerKeeper.GetParams(ctx).MaxProviderConsensusValidators
if err != nil {
return err
}
chainIDs, err := providerKeeper.GetAllRegisteredConsumerChainIDs(ctx)
if err != nil {
return err
}
for _, chainID := range chainIDs {
if err := providerKeeper.SetValidatorSetCap(ctx, chainID, uint32(maxVals)); err != nil {
return err
}
}
return nil
}
…f the staking module (#1993) * Refactor validator set storage * Add comment for getTotalPower * Add provider consensus validator set storage * Add new MaxProviderConsensusValidators param * Add validation for MaxProviderConsensusValidators * Add no_valupdates_staking module * Add function to get MaxProviderConsensusValidators param * Start returning validators in EndBlock * Fix tests * Revert cosmetic change * Revert cosmetic changes * Revert formatting * Add genutil replacer module * Revert formatting * Revert formatting in tests/integration * Revert minor formatting * Fix type * Change wrapped staking to conform to EndBlocker interface * Fix typo * Revert "Fix typo" This reverts commit 62dfd1e. * Add e2e test for inactive vals * Start fixing e2e test * Revert formatting changes * Remove more formatting * Revert extra formatting * Re-wire provider/app.go to use wrapped modules * Remove consumer rewards check * Add inactive provider vals testcase to nightly * Adjust comment * Address comments * Fix nightly test name * feat: Initialize the max validators parameter for existing consumers (#2012) * Add initialization for validator cap * Remove migration test * Fix inconsistent naming
…er chains (#2079) * refactor!: Refactor the validator set storage and add provider consensus validator storage (#1990) * Refactor validator set storage * Add comment for getTotalPower * Add provider consensus validator set storage * Add key to key test * Add unit test for LastTotalProviderConsensusPower * Address comments * feat!: Introduce the MaxProviderConsensusValidators param (#1992) * Refactor validator set storage * Add comment for getTotalPower * Add provider consensus validator set storage * Add new MaxProviderConsensusValidators param * Add validation for MaxProviderConsensusValidators * Add function to get MaxProviderConsensusValidators param * refactor!: Refactor the validator set storage and add provider consensus validator storage (#1990) * Refactor validator set storage * Add comment for getTotalPower * Add provider consensus validator set storage * Add key to key test * Add unit test for LastTotalProviderConsensusPower * Address comments * feat!: Wire the provider module to return ValidatorUpdates, instead of the staking module (#1993) * Refactor validator set storage * Add comment for getTotalPower * Add provider consensus validator set storage * Add new MaxProviderConsensusValidators param * Add validation for MaxProviderConsensusValidators * Add no_valupdates_staking module * Add function to get MaxProviderConsensusValidators param * Start returning validators in EndBlock * Fix tests * Revert cosmetic change * Revert cosmetic changes * Revert formatting * Add genutil replacer module * Revert formatting * Revert formatting in tests/integration * Revert minor formatting * Fix type * Change wrapped staking to conform to EndBlocker interface * Fix typo * Revert "Fix typo" This reverts commit 62dfd1e. * Add e2e test for inactive vals * Start fixing e2e test * Revert formatting changes * Remove more formatting * Revert extra formatting * Re-wire provider/app.go to use wrapped modules * Remove consumer rewards check * Add inactive provider vals testcase to nightly * Adjust comment * Address comments * Fix nightly test name * feat: Initialize the max validators parameter for existing consumers (#2012) * Add initialization for validator cap * Remove migration test * Fix inconsistent naming * test: enable the simulator for the provider module (#2005) * Refactor validator set storage * Add comment for getTotalPower * Add provider consensus validator set storage * Add new MaxProviderConsensusValidators param * Add validation for MaxProviderConsensusValidators * Add no_valupdates_staking module * Add function to get MaxProviderConsensusValidators param * Start returning validators in EndBlock * Fix tests * Revert cosmetic change * Revert cosmetic changes * Revert formatting * Add genutil replacer module * Revert formatting * Revert formatting in tests/integration * Revert minor formatting * Fix type * Change wrapped staking to conform to EndBlocker interface * Fix typo * Revert "Fix typo" This reverts commit 62dfd1e. * Add e2e test for inactive vals * Start fixing e2e test * Revert formatting changes * Remove more formatting * Revert extra formatting * Re-wire provider/app.go to use wrapped modules * Remove consumer rewards check * Add simulator test * Add randomly generated parameters for provider in sim * Add invariant * Add simulation to Makefile and github workflow * Use simcli instead of just passing true * feat!: Let consumer chains choose a minimum stake and validator rank (#2035) * Add minimum stake key * Add MinValidatorRank prefix * Add keeper and tests for new parameters * Utilize MinStake and MaxRank parameters in computing next validators * Mention MinStake and MaxRank in adr * Add test for FulfillsMinStake * Handle multiple validators with same power * Add min stake and max rank to docs * Add minStake and maxRank to proposals * Check for untyped equality * Handle minStake and maxRank in Msgs * Add integration test for min stake and max rank * Rename test and testfile * Update docs/docs/adrs/adr-017-allowing-inactive-validators.md * Add changelog entries for maxrank and minstake * Address comments * Clarify which feature is disabled by setting maxrank * Test validator powers cap and validator set cap into int param testing function * feat!: Rewire dependencies on the staking module (#2056) * Change wiring for mint and gov to use ProviderKeeper instead of StakingKeeper * Add test for IterateBondedValidatorsByPower * Rewire GovKeeper * Fix docstrings * Test other modified functions * Start writing some testing scenarios * Add TotalBondedTokens to expected staking keeper interface * feat: Calculate Top N based on active validators only (#2070) * Add test for inactive vals with top N * Add test case to predefined tests * Fix bonded/active validator distinction * Fix relay test to set max provider consensus vals correctly * feat!: Add a parameter that determines whether consumer chains allow inactive validators to validate them (#2066) * Introduce new AllowInactiveValidators param for consumer chains * Add AllowInactiveValidators param to tests * Set MaxProviderConsensusValidators in tests * Add migration to initialize inactive vals * Add changelog entries for inactive vals param * Add property-based test for inactive vals * Add docs for inactive vals param * Set AllowInactiveVals parameter in e2e test * test: Add e2e tests for inactive vals (#2064) * Start adding e2e test for governance * Debug gov with inactive vals test * Outline for test scenarios where they are tested * Add MaxRank steps * Add e2e tests for min stake and max rank * Revert formatting change * Refactor stepsOptIn * Use adjusted config for e2e tests * Write for more scenarios where they are tested * Add test for mint * Add docstrings for e2e steps * Delete hanging changelog entry * Address comments * Address more comments * Add migration for param * Fix allow inactive validators param test * Fix tests * Add LastProviderConsensusValidatorKey to fully defined keys * Fix key for validator set updates * Add info about genesis/endblock ordering * Add unit test for ProviderValidatorUpdates * Add example to proto definition of max_rank * Remove max rank * Remove references to max rank * Start adding an extension to the simulator * Make invariant fail early when param is 0 * Reorder InitGenesis to put Crisis last * Remove canary * Swap equals for not equals * Disable invariant check when max validators != max provider consensus validators * Make the simulator use a random seed * Remove TODO * Remove decoder * Run go mod tidy * Add migration in UPGRADING.md * Fix tests * Put random seed generation into golang code * Rename simulation jobs * Update UPGRADING.md Co-authored-by: Marius Poke <[email protected]> * Update UPGRADING.md Co-authored-by: Marius Poke <[email protected]> * Update x/ccv/provider/keeper/genesis.go Co-authored-by: Marius Poke <[email protected]> * Mention simulation tests in testing.md * Address some comments * Remake protos * Panic when LastActiveBondedValidators fails * Address some comments * Address comments * Reorder tests * Adjust stake_multiplier to stakeMultiplier * Address comments * Add error logging * Fix reference to bank blocked addrs in simulation * Change hasToValidate to only take into account active validators * Update docs/docs/adrs/adr-017-allowing-inactive-validators.md Co-authored-by: insumity <[email protected]> * Clarify: Slash happens on provider Co-authored-by: insumity <[email protected]> --------- Co-authored-by: Marius Poke <[email protected]> Co-authored-by: insumity <[email protected]>
Description
Closes: Part of #1913
Main changes:
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!
to the type prefix if the change is state-machine breakingCHANGELOG.md
Reviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
!
the type prefix if the change is state-machine breakingSummary by CodeRabbit
New Features
Bug Fixes
Refactor
ConsumerValidator
toConsensusValidator
across the codebase.Tests
Chores